<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>CustomColor Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">CustomColor Structure</p>
<h1>Structure Overview</h1>
<div class="section-text">
Defines a custom color name.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>CustomColor</td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-color">color</a></dt>
<dd>The RGB value of the color.</dd>
<dt><a href="#Property-displayName">displayName</a></dt>
<dd>The user-visible, translatable name of the color</dd>
<dt><a href="#Property-displayNameID">displayNameID</a></dt>
<dd></dd>
<dt><a href="#Property-name">name</a></dt>
<dd>The internal, non-translated name of the color.</dd>
</dl>

<h3>Description</h3>

<div class="section-text">
<p>The developer can define a set of custom color names as 
part of the design. The developer can then reference these names within 
properties. Defining the colors in the palette helps the developer achieve a 
consistent look throughout the report, and allows colors to be refined by 
changing just one place. </p>
<p>Every custom color has three parts: a display name, an 
internal name and an RGB value. The display name is what the developer sees. If 
the palette will be used by people in different countries, then the display name 
can be externalized and translated. The internal name identifies the color 
within the design and in the XML design file. The internal name cannot be 
localized. Finally, the RGB value gives the actual color.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-color">color Property</a></h2>

<p class="section-text">The RGB value of the color.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>Required:</td>
<td>Yes</td></tr>
<tr><td>Display Name:</td>
<td>Color</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Defines the color. The color can be defined using any of 
the following formats:</p>

<ul>
<li>CSS absolute: rgb( R, G, B ), with each value in decimal</li>

<li>CSS relative: rgb( R%, G%, B% )</li>

<li>HTML-style: #RRGGBB</li>

<li>Java-style: 0xRRGGBB</li>

<li>Decimal</li>


</ul></div>

<hr>
<h2><a name="Property-displayName">displayName Property</a></h2>

<p class="section-text">The user-visible, translatable name of the color</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Display Name</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>A custom color can contain a localizable display name. 
This is most useful for colors defined in a library and that will be used within 
the web report designer.</p>

<p>If the design does not provide a display name, then the 
color name appears in the UI.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Text Structure</p></div>

<hr>
<h2><a name="Property-displayNameID">displayNameID Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#resourceKey">resourceKey</a></td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Display Name Key</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>


<hr>
<h2><a name="Property-name">name Property</a></h2>

<p class="section-text">The internal, non-translated name of the color.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#name">name</a></td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>Required:</td>
<td>Yes</td></tr>
<tr><td>Display Name:</td>
<td>Name</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Each color requires an internal name. This is the name 
used in a color property when referencing the custom color. Color names must be 
unique, and must be unique with respect to the 17 standard CSS color names.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Style element <code>color</code> 
property</p>
<p>Style element <code>backgroundColor</code> 
property</p></div>
</body>
</html>
